Skip to content

Document context summarization defaults, limitations, and aggregator params#740

Merged
markbackman merged 3 commits intomainfrom
jh/context-summarization-docs-gaps
Apr 17, 2026
Merged

Document context summarization defaults, limitations, and aggregator params#740
markbackman merged 3 commits intomainfrom
jh/context-summarization-docs-gaps

Conversation

@jamsea
Copy link
Copy Markdown
Contributor

@jamsea jamsea commented Apr 17, 2026

Summary

Closes three kapa.ai coverage gaps on context summarization configuration:

  • Default for enable_auto_context_summarization: now stated explicitly (False) in the fundamentals page, the context-management page, and a new LLMAssistantAggregatorParams section on the reference page.
  • Truncation-only mode: a new Limitations warning in the fundamentals page makes clear Pipecat does not offer truncation without summarization, and that both trigger thresholds cannot be None.
  • Preserving multiple system messages: a second Limitations warning makes explicit that only messages[0] is preserved and that preserving additional system messages is not configurable, pointing to system_instruction as the durable alternative.

Also updates the context-management page to use the non-deprecated enable_auto_context_summarization field name.

Test plan

  • mint dev renders all three pages without errors
  • mint broken-links passes (CI)
  • New LLMAssistantAggregatorParams section appears above LLMAutoContextSummarizationConfig on the reference page
  • Limitations section appears between "Customizing Behavior" and "Custom Summarization Prompts" in the fundamentals page

🤖 Generated with Claude Code

…params

Addresses three kapa.ai coverage gaps: the default value of
enable_auto_context_summarization, the absence of a truncation-only mode,
and the fact that only messages[0] is preserved as a system message.

- Add LLMAssistantAggregatorParams section to the reference page with
  enable_auto_context_summarization (default: False) and
  auto_context_summarization_config, plus a note on the deprecated
  field names.
- Add a Limitations section to the fundamentals page covering the
  no-truncation-only-mode constraint and the single-system-message
  preservation behavior.
- State the default for enable_auto_context_summarization explicitly
  in the fundamentals page.
- Update the context-management page to use the non-deprecated
  enable_auto_context_summarization field name.
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Apr 17, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview Apr 17, 2026, 7:45 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Pipecat documentation to clearly describe context summarization defaults and limitations, and to align configuration examples/reference docs with the non-deprecated enable_auto_context_summarization parameter.

Changes:

  • Explicitly documents that enable_auto_context_summarization defaults to False across guides and reference docs.
  • Adds a “Limitations” section clarifying there’s no truncation-only mode and only messages[0] is preserved as the initial system message.
  • Adds an LLMAssistantAggregatorParams section to the API reference and updates the context-management guide to use the non-deprecated field name.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
pipecat/learn/context-management.mdx Updates the enablement example to use enable_auto_context_summarization and notes the default.
pipecat/fundamentals/context-summarization.mdx Documents default disabled behavior and adds limitations warnings about truncation-only mode and system-message preservation.
api-reference/server/utilities/context-summarization.mdx Expands reference docs with an LLMAssistantAggregatorParams section and clarifies enablement/config responsibilities.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pipecat/fundamentals/context-summarization.mdx Outdated
Comment thread pipecat/fundamentals/context-summarization.mdx Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@markbackman markbackman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks.

@markbackman markbackman merged commit 5a9dfca into main Apr 17, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants